docs: bring the surfaces up to 0.8.1 - #39
Merged
Merged
Conversation
Las docs se habian actualizado para 0.8.0 y despues llego el fix, asi que cuatro lugares seguian describiendo el comportamiento viejo. El peor: el README anunciaba como "known limitation" que la etapa de limpieza borra silencio, que es exactamente lo que 0.8.1 arreglo. - README (x2): la limitacion reemplazada por lo que ahora se garantiza, que los timestamps describen el archivo que entregaste, con el numero de la deriva vieja como referencia. El diagrama del pipeline decia "silence removal". - schemas/init.json: el proposito de ffmpeg decia lo mismo. - skill: el ejemplo de metadata tenia dos campos de cinco, y ahora explica que dice cada brecha entre las tres duraciones. - AGENTS.md: faltaban --preset y --prompt, y el backend decia "local or openai" omitiendo vercel. - sitio: no documentaba el output en absoluto, ni el preset.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs were updated for 0.8.0 and then the fix landed, so four places still described the old behaviour.
The worst one: the README advertised as a known limitation that the cleaning stage removes silence — which is exactly what 0.8.1 fixed. Anyone reading it would have avoided a feature that works.
What was stale
README.md(both)README.md(both)Clean audio (silence removal, ...)schemas/init.json"...conversion, silence removal, noise reduction"skills/trx/SKILL.mdmetadataexample with 2 of the 5 fieldsAGENTS.md--presetor--prompt; backend listed as "local or openai", omitting vercelcommands.mdWhat replaced it
The limitation is now the guarantee it became: timestamps describe the file you handed in, with the old 1.572s drift kept as the reference for what changed.
The skill and the site now explain what each gap between the three durations means, rather than just listing the fields:
inputDurationMsvstranscribedDurationMs— what the cleaning stage changed. Should be within a millisecond; a large gap means a rewritten timeline.transcribedDurationMsvslastCueEndMs— audio that produced no words.That framing is the point of #36: a short transcript reads the same whether the recording is mostly silence, the model stopped early, or the wrong file was passed. Checking these separates the three, and it is faster than filing a bug — which is how this project got one bad report yesterday.
Docs only. 65 tests pass, lint clean.